Plan Activities

This API is used to plan a set of activities for a Case instance.

Resource URI

/v1/cases/{modelid}/instances/{caseinstanceid}/activities

Request Type

HTTP POST

HTTP Header Parameters

Parameter	Description	Accepted Input Values
SAMLart	The SAML artifact received after authentication.	Refer to Login for more information on how to authenticate.

Note: The supported output formats are:

JSON
XML

Request Parameters

Parameter	Description
modelid	The model ID of the Case.
caseinstanceid	The instance ID of the Case instance.

HTTP Payload

The POST accepts the payload content only in the XML format. The request format is as follows:

Sample 1

 <PlanActivities xmlns='http://schemas.cordys.com/casemanagement/execution/1.0' >
	<caseinstanceid>e7657303-cc2b-11e3-e825-170de705dfe8</caseinstanceid>
	<planactivities>
		<activity name="Duplicate Check" state="Registration" allowmultiplan="true"/>
	</planactivities>
</PlanActivities>

Sample 2

 <PlanActivities xmlns="http://schemas.cordys.com/casemanagement/execution/1.0">
      <caseinstanceid>001A6BFA-F5BF-11E0-F0EC-2FBA246BB211</caseinstanceid>
      <planactivities xmlns="http://schemas.cordys.com/casemanagement/execution/1.0">
        <activity name="DiscussProblems" state="Diagnosis">
          <activityinstanceid>1012_John_25052011_DiscussProblems</activityinstanceid>
          <case:activity xmlns:case="http://schemas.cordys.com/casemanagement
            /1.0" id="001A6BFA-F5BF-11E0-F0BE-968A46539DF5" name="DiscussProblems" type="HUMANTASK">
            <HumanInteraction xmlns="http://schemas.cordys.com/notification/workflow/1.0">
              <HumanTaskModelId>001A6BFA-F5BF-11E0-F063-231A8F93DB34</HumanTaskModelId>
              <Subject>DiscussProblems</Subject>
              <SendTo>
                <Target type="user">
                  <Assignee dynamic="false">cn=alice,cn=organizational users,
                   o=system,cn=cordys,cn=defaultInst,o=myorg.com</Assignee>
                </Target>
              </SendTo>
              <DueDate dynamic="false">P0Y0M0DT2H0M0S</DueDate>
            </HumanInteraction>
            <case:messages>
              <case:input>
                <case:message ns="http://schemas.cordys.com/1.0/xforms/processapi" name="DiscussProblemsDeliveryModel_IP" />
              </case:input>
              <case:output>
                <case:message ns="http://schemas.cordys.com/1.0/xforms/processapi" name="DiscussProblemsDeliveryModel_OP" />
              </case:output>
            </case:messages>
            <case:associatedevents />
            <case:duedate type="duration" dynamic="true">sm:data[@name='case:casevariables']/case:casevariables/case:DueTimeSLA</case:duedate>
            <case:escalation />
          </case:activity>
        </activity>
      </planactivities>
    </PlanActivities>

Sample Response XML

 <PlanActivitiesResponse>
	<active_states>
		<state name="Default State" id="RootCaseModelState">67f38610-c428-11e3-e825-170decc01fea</state>
		<state name="Registration" id="00215A60-3EB8-11E2-EF7D-3DBF3116F586">177873d6-3ef3-11e3-e825-170dedc05feb</state>
	</active_states>
</PlanActivitiesResponse>

Sample Response JSON

{
	active_states: {
		state: [2]
		-0:  {
			value: "67f38610-c428-11e3-e825-170decc01fea"
			name: "Default State"
			id: "RootCaseModelState"
		}
		-1:  {
			value: "177873d6-3ef3-11e3-e825-170dedc05feb"
			name: "Registration"
			id: "00215A60-3EB8-11E2-EF7D-3DBF3116F586"
		}
	}
}

pp108 : Plan Activities